home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / tmpl / gimpchainbutton.sgml < prev    next >
Encoding:
SGML Document  |  2003-05-20  |  1.8 KB  |  88 lines
  1. <!-- ##### SECTION Title ##### -->
  2. GimpChainButton
  3.  
  4. <!-- ##### SECTION Short_Description ##### -->
  5. Widget to visually connect two entry widgets.
  6.  
  7. <!-- ##### SECTION Long_Description ##### -->
  8. <para>
  9. This widget provides a button showing either a linked or a broken
  10. chain that can be used to link two entries, spinbuttons, colors
  11. or other GUI elements and show that they may be locked. Use it for
  12. example to connect X and Y ratios to provide the possibility of a 
  13. constrained aspect ratio.
  14. </para>
  15. <para>
  16. The #GimpChainButton only gives visual feedback, it does not really 
  17. connect widgets. You have to take care of locking the values yourself 
  18. by checking the state of the #GimpChainButton whenever a value changes 
  19. in one of the connected widgets and adjusting the other value if 
  20. necessary.
  21. </para>
  22.  
  23. <!-- ##### SECTION See_Also ##### -->
  24. <para>
  25. You may want to use the convenience function gimp_coordinates_new() to set 
  26. up two GimpSizeEntries (see #GimpSizeEntry) linked with a #GimpChainButton.
  27. </para>
  28.  
  29. <!-- ##### STRUCT GimpChainButton ##### -->
  30. <para>
  31.  
  32. </para>
  33.  
  34.  
  35. <!-- ##### MACRO GIMP_CHAIN_BUTTON ##### -->
  36. <para>
  37. Checks if the passed pointer is a pointer to a #GimpChainButton and
  38. performs the cast if valid.
  39. </para>
  40.  
  41. @obj: The pointer to cast.
  42.  
  43.  
  44. <!-- ##### ENUM GimpChainPosition ##### -->
  45. <para>
  46.  
  47. </para>
  48.  
  49. @GIMP_CHAIN_TOP: 
  50. @GIMP_CHAIN_LEFT: 
  51. @GIMP_CHAIN_BOTTOM: 
  52. @GIMP_CHAIN_RIGHT: 
  53.  
  54. <!-- ##### FUNCTION gimp_chain_button_new ##### -->
  55. <para>
  56.  
  57. </para>
  58.  
  59. @position: 
  60. @Returns: 
  61.  
  62.  
  63. <!-- ##### FUNCTION gimp_chain_button_set_active ##### -->
  64. <para>
  65.  
  66. </para>
  67.  
  68. @gcb: 
  69. @is_active: 
  70.  
  71.  
  72. <!-- ##### FUNCTION gimp_chain_button_get_active ##### -->
  73. <para>
  74.  
  75. </para>
  76.  
  77. @gcb: 
  78. @Returns: 
  79.  
  80.  
  81. <!-- ##### SIGNAL GimpChainButton::toggled ##### -->
  82. <para>
  83.  
  84. </para>
  85.  
  86. @gimpchainbutton: the object which received the signal.
  87.  
  88.